Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the doc for DEFAULT_MODEL config #4792

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

pea3nut
Copy link

@pea3nut pea3nut commented May 28, 2024

I saw someone has added the configuration. I just added some doc for it.

Summary by CodeRabbit

  • Documentation
    • Added a section on customizing the default model for initializing new chats and configuring settings.
    • Updated README and README_CN to include information about the new DEFAULT_MODEL option.

Copy link

vercel bot commented May 28, 2024

@pea3nut is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented May 28, 2024

Walkthrough

This update introduces a new feature for customizing the default model used for initializing new chats and the configuration page. This enhancement provides users with increased flexibility in setting up and managing chat functionalities, ensuring a more tailored experience.

Changes

File Change Summary
README.md Added a section detailing the customization of the default model for initializing new chats and configuration pages.
README_CN.md Introduced an optional DEFAULT_MODEL entity for customizing the default model in new chats and settings pages.

Poem

In the code, a change so bright,
A model's path to set just right.
Flexibility now in hand,
Custom chats across the land.
With DEFAULT_MODEL, we take flight,
Tailored chats both day and night. 🌟🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to full the review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between da2e237 and e773bc6.
Files selected for processing (2)
  • README.md (1 hunks)
  • README_CN.md (1 hunks)
Additional Context Used
LanguageTool (19)
README.md (18)

Near line 13: The operating system from Apple is written “macOS”.
Context: ...[Windows][Windows-image]][download-url] [![MacOS][MacOS-image]][download-url] [![Linux][...
Rule ID: MAC_OS


Near line 41: The operating system from Apple is written “macOS”.
Context: ... Compact client (~5MB) on Linux/Windows/MacOS, [download it now](https://github.com/Y...
Rule ID: MAC_OS


Near line 54: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... ## Roadmap - [x] System Prompt: pin a user defined prompt as system prompt [#138](https://...
Rule ID: EN_COMPOUND_ADJECTIVE_INTERNAL


Near line 66: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ....9.11 you can use azure endpoint now. - 🚀 v2.8 now we have a client that runs acr...
Rule ID: ENGLISH_WORD_REPEAT_BEGINNING_RULE


Near line 67: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lient that runs across all platforms! - 🚀 v2.7 let's share conversations as image...
Rule ID: ENGLISH_WORD_REPEAT_BEGINNING_RULE


Near line 68: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tions as image, or share to ShareGPT! - 🚀 v2.0 is released, now you can create pr...
Rule ID: ENGLISH_WORD_REPEAT_BEGINNING_RULE


Near line 73: The operating system from Apple is written “macOS”.
Context: ...署** - 提供体积极小(~5MB)的跨平台客户端(Linux/Windows/MacOS), [下载地址](https://github.com/Yidadaa/Cha...
Rule ID: MAC_OS


Near line 79: A punctuation mark might be missing here.
Context: ...m/PlexPt/awesome-chatgpt-prompts-zh)和英文 - 自动压缩上下文聊天记录,在节省 Token 的同时支持超长对话 - 多国语言支持...
Rule ID: AI_EN_LECTOR_MISSING_PUNCTUATION


Near line 99: The operating system from Apple is written “macOS”.
Context: ...PT 的在线链接。 - 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。 - 🚀 v2.9.11 现在可以使用自定义 Azure...
Rule ID: MAC_OS


Near line 126: Consider adding a hyphen.
Context: ...epository; - Use the fork button in the upper right corner of the page to fork this project...
Rule ID: TOP_LEFT_CORNER


Near line 143: You might be missing the article “the” here.
Context: ...an star or watch this project or follow author to get release notifications in time. ...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_THE


Near line 167: You might be missing the article “a” here.
Context: ...ai api key, join multiple api keys with comma. ### BASE_URL (optional) > Default:...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_A


Near line 242: A comma might be missing here.
Context: ...(optional) > Default: Empty > Example: +llama,+claude-2,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo means a...
Rule ID: AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA


Near line 242: You might be missing the article “the” here.
Context: ...4-turbomeans addllama, claude-2to model list, and removegpt-3.5-turbo` from l...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_THE


Near line 242: You might be missing the article “the” here.
Context: ...l list, and remove gpt-3.5-turbo from list, and display gpt-4-1106-preview as `g...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_THE


Near line 266: The official spelling of this programming framework is “Node.js”.
Context: ... configuration page. ## Requirements NodeJS >= 18, Docker >= 20 ## Development > ...
Rule ID: NODE_JS


Near line 319: You might be missing the article “a” here.
Context: ...atgpt-next-web If your proxy needs password, use: shell -e PROXY_URL="http://12...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_A


Near line 340: Did you mean “Frequently Asked Questions” (= FAQ)?
Context: ...ted)](./docs/cloudflare-pages-en.md) - Frequent Ask Questions - [How to add a new ...
Rule ID: FREQUENT_ASKED_QUESTIONS

README_CN.md (1)

Near line 246: 数词与名词之间一般应存在量词,可能缺少量词。
Context: ...tps://github.com/songquanpeng/one-api): 一站式大模型额度管理平台,支持市面上所有主流大语言模型 ## 开源协议 [MIT...
Rule ID: wa5

Markdownlint (22)
README.md (12)

251: Expected: 0 or 2; Actual: 1
Trailing spaces


259: Expected: 1; Actual: 2
Multiple consecutive blank lines


264: Expected: 1; Actual: 2
Multiple consecutive blank lines


172: null
Blank line inside blockquote


251: null
Lists should be surrounded by blank lines


251: null
Lists should be surrounded by blank lines


253: null
Lists should be surrounded by blank lines


97: null
Bare URL used


151: null
Fenced code blocks should have a language specified


277: null
Fenced code blocks should have a language specified


396: null
Images should have alternate text (alt text)


337: Missing link or image reference definition: "./docs"
Reference links and images should use a label that is defined

README_CN.md (10)

166: Expected: 1; Actual: 2
Multiple consecutive blank lines


159: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


56: null
Blank line inside blockquote


84: null
Blank line inside blockquote


193: null
Blank line inside blockquote


148: null
Lists should be surrounded by blank lines


148: null
Lists should be surrounded by blank lines


150: null
Lists should be surrounded by blank lines


61: null
Fenced code blocks should have a language specified


175: null
Fenced code blocks should have a language specified

Additional comments not posted (2)
README_CN.md (1)

162-166: The documentation for DEFAULT_MODEL is clear and concise.

README.md (1)

259-264: The documentation for DEFAULT_MODEL is clear and concise.

Copy link
Contributor

Your build has completed!

Preview deployment

@rqdmap
Copy link

rqdmap commented Jul 1, 2024

Many people are unable to use this feature due to missing documentation (#4413). Please consider merging this PR at your earliest convenience.

@lloydzhou lloydzhou added the duplicate This issue or pull request already exists label Jul 10, 2024
@lloydzhou
Copy link
Contributor

@pea3nut

i see the DEFAULT_MODEL in README.md, you can rebase and replace the description for this configuration.

@lloydzhou lloydzhou added the documentation Improvements or additions to documentation label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation duplicate This issue or pull request already exists
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants